package com.baturu.mybatisminus.annotation;

import org.apache.ibatis.type.TypeHandler;
import org.apache.ibatis.type.UnknownTypeHandler;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 用于标识一个字段对应的表字段
 * @author huangbin
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {

    /**
     * 对应的表字段名称
     */
    String value() default "";

    /**
     * 是否在生成的insert语句中包含该值，适用于createTime，updateTime类似的字段<br>
     * 在保存时不填充该值，由数据库自动赋值
     */
    boolean insertable() default true;

    /**
     * 是否在生成的update语句包含该值，适用于updateTime类似的字段<br>
     * 在更新时不填充该值，由数据库自动赋值
     */
    boolean updatable() default true;

    /**
     * 为该字段指定特定的类型处理器
     */
    Class<? extends TypeHandler> typeHandler() default UnknownTypeHandler.class;

    /**
     * 用于String类型的字段，当为true时则在dynamicSave和dynamicUpdate时会忽略空字符串
     */
    boolean emptyStringAsNull() default false;


}
